<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html><head>





<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>CISNE-DOC</title></head><body style="width: 780px;">
<div style="text-align: center;"><big style="font-weight: bold;"><big><big><big>CISNE</big></big></big></big>: <big><big><big>I</big>NTEGRATED</big></big> <big><big><big>S</big>WAN</big></big> <big><big><big>E</big>NVIROMENT</big></big><br>
</div>
<br>
<div style="text-align: center;"><img style="width: 400px; height: 231px;" alt="" src="images/about.png"><br>
</div>
<br>
<br>
<ul id="mozToc">
<!--mozToc h1 1 h2 2 h3 3 h4 4 h5 5 h6 6--><li><a href="#mozTocId184296">INTRODUCTION</a></li><li><a href="#mozTocId159364">
THE CONCEPT</a></li><li><a href="#mozTocId761268">
MAIN WINDOW</a><ul><li><a href="#mozTocId602488">ADDING USER DATA TO CISNE</a></li><li><a href="#mozTocId897461">LOADING INPUT GRID</a></li><li><a href="#mozTocId975039">WAVE CASES</a><ul><li><a href="#mozTocId34510">DEFINITION</a></li><li><a href="#mozTocId500834">DATA INPUT</a></li></ul></li></ul></li>
</ul>
<br>
<h1><a class="mozTocH1" name="mozTocId184296"></a><span style="font-weight: bold;">INTRODUCTION</span></h1>

<br>
Project CISNE aims to be a fully integrated pre and post processing
enviroment for SWAN model. It's designed to be an user-friendly easy to
use graphical interface that allows the generation of propagation cases
and graphically display the results.<br>
<br>
This brief manual is meant to introduce CISNE to the normal SWAN user,
so will be focused mostly on how to interact with the User Interface,
and not to explain SWAN commands. <br>
<br>
<br>
<h2><a class="mozTocH1" name="mozTocId159364"></a>
THE CONCEPT</h2>


<br>
CISNE began as an automated method to generate multiple SWAN
simulations. When developing a study or project in a location, several
SWAN properties remain the same, i. e. bathymetry or wave spectrum
shape. Other properties must be set in every simulation, as boundary
conditions. <br>
<br>
CISNE's interface is designed in order to easily define the parameters
that are (or can be) constant in every simulation and provide a list of
simulation cases defined as wave parameters at boundaries, active
boundaries and water level for each case.<br>
<br>
<img style="width: 780px; height: 478px;" alt="" src="images/MainWin.png"><br>
<br>
By using a graphical input method, CISNE can boost the preparation of input cases for SWAN simulations.<br>
<br>
<br>
<h1><a class="mozTocH1" name="mozTocId761268"></a>
MAIN WINDOW</h1>

<br>
Project CISNE's main window handles the pre-processing GUI for SWAN,
managing SWAN interaction and post-processing of results using the menu
bar. <br>
<br>
Main Window is splitted into 2 different sections, which each one handle part of the functionality of CISNE. <br>
<br>
<img style="width: 780px; height: 478px;" alt="" src="images/elements.png"><br>
This table gives a brief description of each section and all elements found in CISNE.<br>
<br>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2" cellspacing="2">
  <tbody>
    <tr>
      <td colspan="1" rowspan="3" style="vertical-align: middle; text-align: center;">USER DATA INTERACTION<br>
      </td>
      <td>TREEWIDGET<br>
      </td>
      <td style="vertical-align: top;">This element displays and stores
the all related data for Input Grids, Computational Grids and Output
Locations (from now on, User Data). Graphically shows the connection
between different elements, making it easy to follow nesting hierarchy
for computational grids.<br>
      </td>
    </tr>
    <tr>
      <td>DISPLAYWIDGET<br>
      </td>
      <td style="vertical-align: top;">This element displays the
representation of all data stored inside TreeWidget, being possible to
move or edit computational grids and output locations to the desired
position while viewing input data (i.e. bathymetry data)<br>
      </td>
    </tr>
    <tr>
      <td>BUTTON TOOLBARS<br>
      </td>
      <td style="vertical-align: top;">These buttons handle the possible actions for User
Data. First toolbar allows the user to add any kind of User Data, which
will be reflected as a new element in the TreeWidget and drawn (if
possible) inside the DisplayWidget. Second Toolbar allows the user to
select and edit/move an item, while the third Toolbar handles zoom
functions for DisplayWidget.<br>
      </td>
    </tr>
    <tr>
      <td colspan="1" rowspan="3" style="vertical-align: middle; text-align: center;">SWAN COMMAND PARAMETERS<br>
      </td>
      <td>SWAN COMMANDS<br>
      </td>
      <td style="vertical-align: top;">This grid contains all
implemented SWAN commands that can be added to input files using CISNE.
User can modify the values to fit the desired configuration<br>
      </td>
    </tr>
    <tr>
      <td>WAVE CASES<br>
      </td>
      <td style="vertical-align: top;">This list contains all the different wave parameters assigned to each simulation case in SWAN. Each line is a simulation<br>
      </td>
    </tr>
    <tr>
      <td>OUTPUT PARAMETERS<br>
      </td>
      <td style="vertical-align: top;">This element allows the user to select which computation parameter to store in each output location.<br>
      </td>
    </tr>
  </tbody>
</table>
<br>
<br>
<h2><a class="mozTocH2" name="mozTocId602488"></a>ADDING USER DATA TO CISNE</h2>
<br>
User Data, which includes Input Grids, Computational Grids and Output
Locations, can be added using the button toolbars located between
TreeWidget and DisplayWidget.<br>
<br>
<table style="text-align: left; width: 779px; height: 221px; margin-left: auto; margin-right: auto;" border="0" cellpadding="2" cellspacing="2">
  <tbody>
    <tr align="center">
      <td style="vertical-align: top;"><img style="width: 20px; height: 20px;" alt="" src="images/addIGrid.png"><br>
      </td>
      <td style="vertical-align: top; text-align: left;">Adds an Input Grid: Bathymetry, Vegetation, Current, Wind or Friction. Selecting
this button opens a new dialog which allows the user to select the type
of Input Grid and internal displayed name for the grid. <br>
      </td>
    </tr>
    <tr align="center">
      <td style="vertical-align: top;"><img style="width: 20px; height: 20px;" alt="" src="images/addCGrid.png"><br>
      </td>
      <td style="vertical-align: top; text-align: left;">Adds a
Computational Grid. Selecting this button opens a new dialog which
allows the user to select the internal displayed name and parent grid.
If parent grid is NONE, the computational grid is considered as a main
grid, while selecting another grid as parent means that current grid
becomes a nested grid. After closing the pop-up dialog, user must draw
inside DisplayWidget the dimensions and location of the grid.
(Push-drag-Release)<br>
      </td>
    </tr>
    <tr align="center">
      <td style="vertical-align: top;"><img style="width: 20px; height: 20px;" alt="" src="images/addCPoint.png"><br>
      </td>
      <td style="vertical-align: top; text-align: left;">Adds
Output Point Location (Control Point). This button allows the user to
select and draw inside the DisplayWidget the position of a Control
Point (Output Location).<br>
      </td>
    </tr>
    <tr>
      <td style="vertical-align: top; text-align: center;"><img style="width: 20px; height: 20px;" alt="" src="images/addCLine.png"><br>
      </td>
      <td style="vertical-align: top; text-align: left;">Add Output Line. DISABLED IN CURRENT VERSION.<br>
      </td>
    </tr>
  </tbody>
</table>
<br>
<br>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
  <tbody>
    <tr align="center">
      <td style="vertical-align: top;"><img style="width: 335px; height: 157px;" alt="" src="images/LoadInputGrid.png"><br>
      </td>
    </tr>
    <tr align="center">
      <td style="vertical-align: top;"><small>Dialog displayed when clicked "Add Input Grid" button. <br>
      </small></td>
    </tr>
  </tbody>
</table>
<br>
<br>
Once added User Data elements to TreeWidget, the user can define and
modify the element's parameters, which are different depending on which
kind of item is selected.<br><br>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
  <tbody>
    <tr align="center">
      <td style="vertical-align: top;"><img style="width: 188px; height: 275px;" alt="" src="images/inputgriddata.png"><br>
      </td>
    </tr>
    <tr align="center">
      <td style="vertical-align: top;"><small>This image shows some
properties that can be defined for Input Grids. Selecting an item
displays a short descriptionat the bottom.</small><br>
      </td>
    </tr>
  </tbody>
</table>
<br>
<h2><a class="mozTocH2" name="mozTocId897461"></a>LOADING INPUT GRID</h2>
SWAN load data for input grids from ASCII files. CISNE is able to read
those files and display them, allowing the user to check that
everything is ok, or define needed properties. <br>
<br>
Right now, CISNE is able to handle STRUCTURED grids only. Apart from
basic ASCII files containing rows of data, with or without header,
CISNE is able to read and process ASCII .grd files written with Surfer
software. If one of these files is loaded, CISNE will retrieve nearly
all important properties and save them (Xmin, Ymin, header, idla, ...).
<br>
<br>
Some interesting properties are:<br>
<ul>
  <li>Swap checkbox changes depths and elevation, which will be interpreted by SWAN as [fac] parameter equal to -1.</li>
  <li>Flip checkbox allows the user to flip upside down grid data, that is, tell SWAN that idla is type 1-2 or 3-4.</li>
  <li>Style is a CISNE property that will draw input grids as colored
images or contourlines. This is useful when the user has several Input
Grids.</li>
  <li>Opacity handles the opacity of colored images. Also useful to display many Input Grids and show/hide some of them.</li>
</ul>
<br>
<h2><a class="mozTocH1" name="mozTocId975039"></a>WAVE CASES</h2>
<h3><a class="mozTocH3" name="mozTocId34510"></a>DEFINITION</h3>
Wave Cases are defined under CISNE as a vector containing all needed
data to generate a unique simulation along with all data defined and
handled by CISNE.<br>
<br>
The standard format of Wave Cases is a line containing at least 5 elements separated by spaces:<br>
<br>
<div style="text-align: center;">SIDE HEIGHT PERIOD DIRECTION WATER_LEVEL<br>
</div>

<br>
<br>
<ul>
  
  <li>Side, height, period and direction correspond to the
same parameters in BOUNDSPEC command. (Check SWAN user manual for more
information) <br>
</li>
  <li>Water level corresponds to the SET LEVEL command. Each simulation
may have different tide level, so it's included in this vector.<br>
  </li>
</ul>

If the line has more than 5 elements, then CISNE will understand that
there are multiple active boundaries (1+number of extra elements).<br>
<br>
<h3><a class="mozTocH3" name="mozTocId500834"></a>DATA INPUT</h3>
Wave Cases can be handled graphically using the Wave Cases Listbox Buttons.<br>
<br>
<table style="text-align: left; width: 779px; height: 158px;" border="0" cellpadding="2" cellspacing="2">
  <tbody>
    <tr>
      <td style="vertical-align: middle;"><img style="width: 16px; height: 16px;" alt="" src="images/AddSCase.png"><br>
      </td>
      <td style="vertical-align: middle;">Add single case: Shows a dialog that simplifies the task of adding new cases.<br>
      <br>
      </td>
      <td colspan="1" rowspan="3" style="vertical-align: top;">&nbsp;&nbsp;&nbsp;&nbsp; <img style="width: 180px; height: 200px;" alt="" src="images/CaseDlg.png"><br>
      </td>
    </tr>
    <tr>
      <td style="vertical-align: middle;"><img style="width: 16px; height: 16px;" alt="" src="images/AddCaseList.png"><br>
      </td>
      <td>Add case list: Users can load a list of cases included in a text file where each row is a single case.</td>
    </tr>
    <tr>
      <td style="vertical-align: middle;"><img style="width: 16px; height: 16px;" alt="" src="images/DelSCase.png"><br>
      </td>
      <td>Del single case: Deletes the selected case<br>
      <br>
      </td>
    </tr>
    <tr>
      <td style="vertical-align: top;"><img style="width: 16px; height: 16px;" alt="" src="images/DelCaseList.png"><br>
      </td>
      <td>Del case list: Removes all the cases<br>
      <br>
      <br>
      </td>
      <td style="vertical-align: top;"><br>
      </td>
    </tr>
  </tbody>
</table>
<br>
<br>
<br>
<h2>CISNE SETTINGS</h2>
CISNE can handle several Display settings, allowing the user to choose custom colormaps, grid settings or canvas length.<br>
It does also allow to choose the local installation of SWAN, so it can
run the different simulations without leaving CISNE Main Window.<br>
<br>
NOTE: Right now, to run SWAN under Linux, CISNE must copy a batch
script name cisneSwan in SWAN's folder, so the user must be able to
write in that folder. As an option, system admin can manually copy and
paste the file. It's a modified version of SWAN's script to allow using
external files as input. <br>
<br>
<div style="text-align: center;"><img style="width: 655px; height: 531px;" alt="" src="images/Settings.png"><br>
</div>
<br>
<br>
<br>
<h1>POST-PROCESSING</h1>
CISNE can post-process and draw the results of a list of simulation
cases. The user just have to select the folder containing the project
(the one defined in Main Window which contains the SWN and OUT
subfolders). CISNE will read out all available cases with all the
needed data.<br>
<br>
<h2>DRAW MESH</h2>
<img style="width: 780px; height: 533px;" alt="" src="images/DrawMesh.png"><br>
This Window displays the output parameters for the entire computational
grid mesh. User can select any available case in the project. Each case is defined by wave parameters. <br>
<br>
To improve the data representation, CISNE handles a special filetype with extension .cst that draws a detailed coastline.<br>
The file format is the following:<br>
<br>
<table style="text-align: left; width: 100%; margin-left: auto; margin-right: auto;" border="0" cellpadding="2" cellspacing="2">
  <tbody>
    <tr>
      <td style="vertical-align: top;">
      <pre>COAST</pre>

      <pre>numpolygons</pre>

      <pre>numelem isclosed</pre>

      <pre>Px,Py, Pz</pre>

      <pre>...</pre>

      <pre>...</pre>

      <pre>...</pre>

      </td>
      <td style="vertical-align: top;">
      <pre>first line must always be the keyword COAST</pre>
      <pre>second line is the number of different lines that the file includes</pre>
      <pre>at the beginning of a polygon write number of points followed by 1 if closed or 0 if&nbsp; the line is open</pre>
      <pre>coordinates of each point that defines the coast line, as X,Y,Z</pre>
      <pre><br>At the end of the coast line, begin with the next one </pre>
      </td>
    </tr>
  </tbody>
</table>
<br>
<br>
<h2>DRAW SPECTRUM</h2>
This window is quite similar to Draw Mesh, except that it draws the
output location's energy spectrum. The user can select which case to
process, and which Output Location inside that SWAN run.<br>
<br>
<img style="width: 780px; height: 623px;" alt="" src="images/DrawSpt.png"><br>
<br>



</body></html>